package co.yixiang.common.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

/**
 * Druid配置属性类
 * 该类主要用于从配置文件中读取数据库连接池的相关配置，并将其应用到DruidDataSource对象中
 **/
@Configuration(proxyBeanMethods = false)
public class DruidProperties
{
    // 从配置文件中读取初始连接数，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.initialSize}")
    private int initialSize;

    // 从配置文件中读取最小空闲连接数，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.minIdle}")
    private int minIdle;

    // 从配置文件中读取最大活跃连接数，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.maxActive}")
    private int maxActive;

    // 从配置文件中读取获取连接的最大等待时间，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.maxWait}")
    private int maxWait;

    // 从配置文件中读取空闲连接检测的周期，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.timeBetweenEvictionRunsMillis}")
    private int timeBetweenEvictionRunsMillis;

    // 从配置文件中读取连接在池中最小空闲的时间，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.minEvictableIdleTimeMillis}")
    private int minEvictableIdleTimeMillis;

    // 从配置文件中读取连接在池中最大空闲的时间，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.maxEvictableIdleTimeMillis}")
    private int maxEvictableIdleTimeMillis;

    // 从配置文件中读取用于检测连接是否有效的SQL查询，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.validationQuery}")
    private String validationQuery;

    // 从配置文件中读取是否在空闲时检测连接的有效性，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.testWhileIdle}")
    private boolean testWhileIdle;

    // 从配置文件中读取是否在获取连接时检测其有效性，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.testOnBorrow}")
    private boolean testOnBorrow;

    // 从配置文件中读取是否在归还连接时检测其有效性，并将其注入到DruidDataSource对象中
    @Value("${spring.datasource.druid.testOnReturn}")
    private boolean testOnReturn;

    /**
     * 配置Druid数据源
     * 该方法将从配置文件中读取到的数据库连接池配置应用到DruidDataSource对象中
     *
     * @param datasource DruidDataSource对象，用于注入配置
     * @return 返回配置完成的DruidDataSource对象
     */
    public DruidDataSource dataSource(DruidDataSource datasource)
    {
        /** 配置初始化大小、最小、最大 */
        datasource.setInitialSize(initialSize);
        datasource.setMaxActive(maxActive);
        datasource.setMinIdle(minIdle);

        /** 配置获取连接等待超时的时间 */
        datasource.setMaxWait(maxWait);

        /** 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 */
        datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

        /** 配置一个连接在池中最小、最大生存的时间，单位是毫秒 */
        datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        datasource.setMaxEvictableIdleTimeMillis(maxEvictableIdleTimeMillis);

        /**
         * 用来检测连接是否有效的sql，要求是一个查询语句，常用select 'x'。如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会起作用。
         */
        datasource.setValidationQuery(validationQuery);
        /** 建议配置为true，不影响性能，并且保证安全性。申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。 */
        datasource.setTestWhileIdle(testWhileIdle);
        /** 申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。 */
        datasource.setTestOnBorrow(testOnBorrow);
        /** 归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。 */
        datasource.setTestOnReturn(testOnReturn);
        return datasource;
    }
}
